<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>fields - compile-time class fields - Perldoc Browser</title>
    <link rel="search" href="https://perldoc.perl.org/opensearch.xml" type="application/opensearchdescription+xml" title="Perldoc Browser">
    <link rel="canonical" href="https://perldoc.perl.org/fields">
    <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/css/bootstrap.min.css" integrity="sha384-JcKb8q3iqJ61gNV9KGb8thSsNjpSL0n8PARn9HuZOnIxN0hoP+VmmDGMN5t9UJ0Z" crossorigin="anonymous">
    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/stackoverflow-light.min.css" integrity="sha512-cG1IdFxqipi3gqLmksLtuk13C+hBa57a6zpWxMeoY3Q9O6ooFxq50DayCdm0QrDgZjMUn23z/0PMZlgft7Yp5Q==" crossorigin="anonymous" />
    <style>
      body {
        background: #f4f4f5;
        color: #020202;
      }
      .navbar-dark {
        background-image: -webkit-linear-gradient(top, #005f85 0, #002e49 100%);
        background-image: -o-linear-gradient(top, #005f85 0, #002e49 100%);
        background-image: linear-gradient(to bottom, #005f85 0, #002e49 100%);
        filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff005f85', endColorstr='#ff002e49', GradientType=0);
        background-repeat: repeat-x;
      }
      .navbar-dark .navbar-nav .nav-link,
      .navbar-dark .navbar-nav .nav-link:focus { color: #fff }
      .navbar-dark .navbar-nav .nav-link:hover { color: #ffef68 }
      #wrapperlicious {
        margin: 0 auto;
        font: 0.9em 'Helvetica Neue', Helvetica, sans-serif;
        font-weight: normal;
        line-height: 1.5em;
        margin: 0;
        padding: 0;
      }
      #wrapperlicious h1 { font-size: 1.5em }
      #wrapperlicious h2 { font-size: 1.3em }
      #wrapperlicious h3 { font-size: 1.1em }
      #wrapperlicious h4 { font-size: 0.9em }
      #wrapperlicious h1, #wrapperlicious h2, #wrapperlicious h3,
      #wrapperlicious h4, #wrapperlicious dt {
        color: #020202;
        margin-top: 1em;
        margin-bottom: 1em;
        position: relative;
        font-weight: bold;
      }
      #wrapperlicious a { color: inherit; text-decoration: underline }
      #wrapperlicious #toc { text-decoration: none }
      #wrapperlicious a:hover { color: #2a2a2a }
      #wrapperlicious a img { border: 0 }
      #wrapperlicious :not(pre) > code {
        color: inherit;
        background-color: rgba(0, 0, 0, 0.04);
        border-radius: 3px;
        font: 0.9em Consolas, Menlo, Monaco, monospace;
        padding: 0.3em;
      }
      #wrapperlicious dd {
        margin: 0;
        margin-left: 2em;
      }
      #wrapperlicious dt {
        color: #2a2a2a;
        font-weight: bold;
        margin-left: 0.9em;
      }
      #wrapperlicious p {
        margin-bottom: 1em;
        margin-top: 1em;
      }
      #wrapperlicious li > p {
        margin-bottom: 0;
        margin-top: 0;
      }
      #wrapperlicious pre {
        border: 1px solid #c1c1c1;
        border-radius: 3px;
        font: 100% Consolas, Menlo, Monaco, monospace;
        margin-bottom: 1em;
        margin-top: 1em;
      }
      #wrapperlicious pre > code {
        display: block;
        background-color: #f6f6f6;
        font: 0.9em Consolas, Menlo, Monaco, monospace;
        line-height: 1.5em;
        text-align: left;
        white-space: pre;
        padding: 1em;
      }
      #wrapperlicious dl, #wrapperlicious ol, #wrapperlicious ul {
        margin-bottom: 1em;
        margin-top: 1em;
      }
      #wrapperlicious ul {
        list-style-type: square;
      }
      #wrapperlicious ul ul {
        margin-bottom: 0px;
        margin-top: 0px;
      }
      #footer {
        font-size: 0.8em;
        padding-top: 0.5em;
        text-align: center;
      }
      #more {
        display: inline;
        font-size: 0.8em;
      }
      #perldocdiv {
        background-color: #fff;
        border: 1px solid #c1c1c1;
        border-bottom-left-radius: 5px;
        border-bottom-right-radius: 5px;
        margin-left: auto;
        margin-right: auto;
        padding: 3em;
        padding-top: 1em;
        max-width: 960px;
      }
      #moduleversion { float: right }
      #wrapperlicious .leading-notice {
        font-style: italic;
        padding-left: 1em;
        margin-top: 1em;
        margin-bottom: 1em;
      }
      #wrapperlicious .permalink {
        display: none;
        left: -0.75em;
        position: absolute;
        padding-right: 0.25em;
        text-decoration: none;
      }
      #wrapperlicious h1:hover .permalink, #wrapperlicious h2:hover .permalink,
      #wrapperlicious h3:hover .permalink, #wrapperlicious h4:hover .permalink,
      #wrapperlicious dt:hover .permalink {
        display: block;
      }
    </style>
    <!-- Global site tag (gtag.js) - Google Analytics -->
    <script async src="https://www.googletagmanager.com/gtag/js?id=G-KVNWBNT5FB"></script>
    <script>
      window.dataLayer = window.dataLayer || [];
      function gtag(){dataLayer.push(arguments);}
      gtag('js', new Date());

      gtag('config', 'G-KVNWBNT5FB');
      gtag('config', 'UA-50555-3');
    </script>
  </head>
  <body>
    <nav class="navbar navbar-expand-md navbar-dark bg-dark justify-content-between">
  <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation">
    <span class="navbar-toggler-icon"></span>
  </button>
  <a class="navbar-brand" href="https://perldoc.perl.org/">Perldoc Browser</a>
  <div class="collapse navbar-collapse" id="navbarNav">
    <ul class="navbar-nav mr-auto">
      <li class="nav-item dropdown text-nowrap">
        <a class="nav-link dropdown-toggle" href="fields.html#" id="dropdownlink-stable" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">5.35.0</a>
        <div class="dropdown-menu" aria-labelledby="dropdownlink-stable">
          <a class="dropdown-item" href="https://perldoc.perl.org/fields">Latest</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.2/fields">5.38.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.1/fields">5.38.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.0/fields">5.38.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.3/fields">5.36.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.2/fields">5.36.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.1/fields">5.36.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.0/fields">5.36.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.3/fields">5.34.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.2/fields">5.34.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.1/fields">5.34.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.0/fields">5.34.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.32.1/fields">5.32.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.32.0/fields">5.32.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.3/fields">5.30.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.2/fields">5.30.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.1/fields">5.30.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.0/fields">5.30.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.3/fields">5.28.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.2/fields">5.28.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.1/fields">5.28.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.0/fields">5.28.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.3/fields">5.26.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.2/fields">5.26.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.1/fields">5.26.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.0/fields">5.26.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.4/fields">5.24.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.3/fields">5.24.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.2/fields">5.24.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.1/fields">5.24.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.0/fields">5.24.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.4/fields">5.22.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.3/fields">5.22.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.2/fields">5.22.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.1/fields">5.22.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.0/fields">5.22.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.3/fields">5.20.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.2/fields">5.20.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.1/fields">5.20.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.0/fields">5.20.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.4/fields">5.18.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.3/fields">5.18.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.2/fields">5.18.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.1/fields">5.18.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.0/fields">5.18.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.3/fields">5.16.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.2/fields">5.16.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.1/fields">5.16.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.0/fields">5.16.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.4/fields">5.14.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.3/fields">5.14.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.2/fields">5.14.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.1/fields">5.14.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.0/fields">5.14.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.5/fields">5.12.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.4/fields">5.12.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.3/fields">5.12.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.2/fields">5.12.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.1/fields">5.12.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.0/fields">5.12.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.10.1/fields">5.10.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.10.0/fields">5.10.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.9/fields">5.8.9</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.8/fields">5.8.8</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.7/fields">5.8.7</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.6/fields">5.8.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.5/fields">5.8.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.4/fields">5.8.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.3/fields">5.8.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.2/fields">5.8.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.1/fields">5.8.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.0/fields">5.8.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.6.2/fields">5.6.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.6.1/fields">5.6.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.6.0/fields">5.6.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_04/fields">5.005_04</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_03/fields">5.005_03</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_02/fields">5.005_02</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_01/fields">5.005_01</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005/fields">5.005</a>
        </div>
      </li>
      <li class="nav-item dropdown text-nowrap">
        <a class="nav-link dropdown-toggle" href="fields.html#" id="dropdownlink-dev" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Dev</a>
        <div class="dropdown-menu" aria-labelledby="dropdownlink-dev">
          <a class="dropdown-item" href="https://perldoc.perl.org/blead/fields">blead</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.6/fields">5.39.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.5/fields">5.39.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.4/fields">5.39.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.3/fields">5.39.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.2/fields">5.39.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.1/fields">5.39.1</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.0-RC2/fields">5.38.0-RC2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.0-RC1/fields">5.38.0-RC1</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.11/fields">5.37.11</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.10/fields">5.37.10</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.9/fields">5.37.9</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.8/fields">5.37.8</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.7/fields">5.37.7</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.6/fields">5.37.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.5/fields">5.37.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.4/fields">5.37.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.3/fields">5.37.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.2/fields">5.37.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.1/fields">5.37.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.0/fields">5.37.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.11/fields">5.35.11</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.10/fields">5.35.10</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.9/fields">5.35.9</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.8/fields">5.35.8</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.7/fields">5.35.7</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.6/fields">5.35.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.5/fields">5.35.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.4/fields">5.35.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.3/fields">5.35.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.2/fields">5.35.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.1/fields">5.35.1</a>
          <a class="dropdown-item active" href="fields.html">5.35.0</a>
        </div>
      </li>
      <li class="nav-item dropdown text-nowrap">
        <a class="nav-link dropdown-toggle" href="fields.html#" id="dropdownlink-nav" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Documentation</a>
        <div class="dropdown-menu" aria-labelledby="dropdownlink-nav">
          <a class="dropdown-item" href="perl.html">Perl</a>
          <a class="dropdown-item" href="perlintro.html">Intro</a>
          <a class="dropdown-item" href="perl.html#Tutorials">Tutorials</a>
          <a class="dropdown-item" href="perlfaq.html">FAQs</a>
          <a class="dropdown-item" href="perl.html#Reference-Manual">Reference</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="perlop.html">Operators</a>
          <a class="dropdown-item" href="functions.html">Functions</a>
          <a class="dropdown-item" href="variables.html">Variables</a>
          <a class="dropdown-item" href="modules.html">Modules</a>
          <a class="dropdown-item" href="perlutil.html">Utilities</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="perlcommunity.html">Community</a>
          <a class="dropdown-item" href="perlhist.html">History</a>
        </div>
      </li>
    </ul>
    <ul class="navbar-nav">
      <script>
        function set_expand (expand) {
          var perldocdiv = document.getElementById('perldocdiv');
          var width = window.getComputedStyle(perldocdiv).getPropertyValue('max-width');
          var expanded = (width == '' || width == 'none') ? true : false;
          if (expand === null) {
            expand = !expanded;
          }
          if ((expand && !expanded) || (!expand && expanded)) {
            perldocdiv.style.setProperty('max-width', expand ? 'none' : '960px');
            var button_classlist = document.getElementById('content-expand-button').classList;
            if (expand) {
              button_classlist.add('btn-light');
              button_classlist.remove('btn-outline-light');
            } else {
              button_classlist.add('btn-outline-light');
              button_classlist.remove('btn-light');
            }
          }
          return expand;
        }
        function toggle_expand () {
          var expand = set_expand(null);
          document.cookie = 'perldoc_expand=' + (expand ? 1 : 0) + '; path=/; expires=Tue, 19 Jan 2038 03:14:07 UTC';
        }
        function read_expand () {
          return document.cookie.split(';').some(function (item) { return item.indexOf('perldoc_expand=1') >= 0 });
        }
        if (document.readyState === 'loading') {
          document.addEventListener('DOMContentLoaded', function () {
            if (read_expand()) {
              set_expand(true);
            }
          });
        } else if (read_expand()) {
          set_expand(true);
        }
      </script>
      <button id="content-expand-button" type="button" class="btn btn-outline-light d-none d-lg-inline-block mr-2" onclick="toggle_expand()">Expand</button>
    <ul>
    <form class="form-inline" method="get" action="https://perldoc.perl.org/5.35.0/search">
      <input class="form-control mr-3" type="search" name="q" placeholder="Search" aria-label="Search">
    </form>
  </div>
</nav>

    <div id="wrapperlicious" class="container-fluid">
      <div id="perldocdiv">
        <div id="links">
          <a href="fields.html">fields</a>
          <div id="more">
            (<a href="fields.txt">source</a>,
            <a href="https://metacpan.org/pod/fields">CPAN</a>)
          </div>
            <div id="moduleversion">version 2.24</div>
        </div>
        <div class="leading-notice">
          You are viewing the version of this documentation from Perl 5.35.0.
            This is a development version of Perl.
        </div>
        <h1><a id="toc">CONTENTS</a></h1>
                  <ul>
              <li>
                <a class="text-decoration-none" href="fields.html#NAME">NAME</a>
              </li>
              <li>
                <a class="text-decoration-none" href="fields.html#SYNOPSIS">SYNOPSIS</a>
              </li>
              <li>
                <a class="text-decoration-none" href="fields.html#DESCRIPTION">DESCRIPTION</a>
              </li>
              <li>
                <a class="text-decoration-none" href="fields.html#SEE-ALSO">SEE ALSO</a>
              </li>
          </ul>

      <h1 id="NAME"><a class="permalink" href="fields.html#NAME">#</a>NAME</h1>

<p>fields - compile-time class fields</p>

<h1 id="SYNOPSIS"><a class="permalink" href="fields.html#SYNOPSIS">#</a>SYNOPSIS</h1>

<pre><code>{
    package Foo;
    use fields qw(foo bar _Foo_private);
    sub new {
        my Foo $self = shift;
        unless (ref $self) {
            $self = fields::new($self);
            $self-&gt;{_Foo_private} = &quot;this is Foo&#39;s secret&quot;;
        }
        $self-&gt;{foo} = 10;
        $self-&gt;{bar} = 20;
        return $self;
    }
}

my $var = Foo-&gt;new;
$var-&gt;{foo} = 42;

# this will generate a run-time error
$var-&gt;{zap} = 42;

# this will generate a compile-time error
my Foo $foo = Foo-&gt;new;
$foo-&gt;{zap} = 24;

# subclassing
{
    package Bar;
    use base &#39;Foo&#39;;
    use fields qw(baz _Bar_private);        # not shared with Foo
    sub new {
        my $class = shift;
        my $self = fields::new($class);
        $self-&gt;SUPER::new();                # init base fields
        $self-&gt;{baz} = 10;                  # init own fields
        $self-&gt;{_Bar_private} = &quot;this is Bar&#39;s secret&quot;;
        return $self;
    }
}</code></pre>

<h1 id="DESCRIPTION"><a class="permalink" href="fields.html#DESCRIPTION">#</a>DESCRIPTION</h1>

<p>The <code>fields</code> pragma enables compile-time and run-time verified class fields.</p>

<p>NOTE: The current implementation keeps the declared fields in the %FIELDS hash of the calling package, but this may change in future versions. Do <b>not</b> update the %FIELDS hash directly, because it must be created at compile-time for it to be fully useful, as is done by this pragma.</p>

<p>If a typed lexical variable (<code>my Class $var</code>) holding a reference is used to access a hash element and a package with the same name as the type has declared class fields using this pragma, then the hash key is verified at compile time. If the variables are not typed, access is only checked at run time.</p>

<p>The related <code>base</code> pragma will combine fields from base classes and any fields declared using the <code>fields</code> pragma. This enables field inheritance to work properly. Inherited fields can be overridden but will generate a warning if warnings are enabled.</p>

<p><b>Only valid for Perl 5.8.x and earlier:</b> Field names that start with an underscore character are made private to the class and are not visible to subclasses.</p>

<p>Also, <b>in Perl 5.8.x and earlier</b>, this pragma uses pseudo-hashes, the effect being that you can have objects with named fields which are as compact and as fast arrays to access, as long as the objects are accessed through properly typed variables.</p>

<p>The following functions are supported:</p>

<dl>

<dt id="new"><a class="permalink" href="fields.html#new">#</a>new</dt>
<dd>

<p>fields::new() creates and blesses a hash comprised of the fields declared using the <code>fields</code> pragma into the specified class. It is the recommended way to construct a fields-based object.</p>

<p>This makes it possible to write a constructor like this:</p>

<pre><code>package Critter::Sounds;
use fields qw(cat dog bird);

sub new {
    my $self = shift;
    $self = fields::new($self) unless ref $self;
    $self-&gt;{cat} = &#39;meow&#39;;                      # scalar element
    @$self{&#39;dog&#39;,&#39;bird&#39;} = (&#39;bark&#39;,&#39;tweet&#39;);    # slice
    return $self;
}</code></pre>

</dd>
<dt id="phash"><a class="permalink" href="fields.html#phash">#</a>phash</dt>
<dd>

<p><b>This function only works in Perl 5.8.x and earlier.</b> Pseudo-hashes were removed from Perl as of 5.10. Consider using restricted hashes or fields::new() instead (which itself uses restricted hashes under 5.10+). See <a href="./Hash::Util.html">Hash::Util</a>. Using fields::phash() under 5.10 or higher will cause an error.</p>

<p>fields::phash() can be used to create and initialize a plain (unblessed) pseudo-hash. This function should always be used instead of creating pseudo-hashes directly.</p>

<p>If the first argument is a reference to an array, the pseudo-hash will be created with keys from that array. If a second argument is supplied, it must also be a reference to an array whose elements will be used as the values. If the second array contains less elements than the first, the trailing elements of the pseudo-hash will not be initialized. This makes it particularly useful for creating a pseudo-hash from subroutine arguments:</p>

<pre><code>sub dogtag {
   my $tag = fields::phash([qw(name rank ser_num)], [@_]);
}</code></pre>

<p>fields::phash() also accepts a list of key-value pairs that will be used to construct the pseudo hash. Examples:</p>

<pre><code>my $tag = fields::phash(name =&gt; &quot;Joe&quot;,
                        rank =&gt; &quot;captain&quot;,
                        ser_num =&gt; 42);

my $pseudohash = fields::phash(%args);</code></pre>

</dd>
</dl>

<h1 id="SEE-ALSO"><a class="permalink" href="fields.html#SEE-ALSO">#</a><a id="SEE"></a>SEE ALSO</h1>

<p><a href="base.html">base</a>, <a href="./Hash::Util.html">Hash::Util</a></p>


      </div>
      <div id="footer">
        <p>Perldoc Browser is maintained by Dan Book (<a href="https://metacpan.org/author/DBOOK">DBOOK</a>). Please contact him via the <a href="https://github.com/Grinnz/perldoc-browser/issues">GitHub issue tracker</a> or <a href="mailto:dbook@cpan.org">email</a> regarding any issues with the site itself, search, or rendering of documentation.</p>

<p>The Perl documentation is maintained by the Perl 5 Porters in the development of Perl. Please contact them via the <a href="https://github.com/Perl/perl5/issues">Perl issue tracker</a>, the <a href="https://lists.perl.org/list/perl5-porters.html">mailing list</a>, or <a href="https://kiwiirc.com/client/irc.perl.org/p5p">IRC</a> to report any issues with the contents or format of the documentation.</p>


      </div>
    </div>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.5.1/jquery.slim.min.js" integrity="sha512-/DXTXr6nQodMUiq+IUJYCt2PPOUjrHJ9wFrqpJ3XkgPNOZVfMok7cRw6CSxyCQxXn6ozlESsSh1/sMCTF1rL/g==" crossorigin="anonymous"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.16.1/umd/popper.min.js" integrity="sha512-ubuT8Z88WxezgSqf3RLuNi5lmjstiJcyezx34yIU2gAHonIi27Na7atqzUZCOoY4CExaoFumzOsFQ2Ch+I/HCw==" crossorigin="anonymous"></script>
    <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/js/bootstrap.min.js" integrity="sha384-B4gt1jrGC7Jh4AgTPSdUtOBvfO8shuf57BaghqFfPlYxofvL8/KUEfYiJOMMV+rV" crossorigin="anonymous"></script>
    <script src="../highlight.pack.js"></script>
    <script>hljs.highlightAll();</script>
  </body>
</html>
